<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: MySpace::EndPoint</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">MySpace::EndPoint</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/myspace/config/end_point_rb.html">
                myspace/config/end_point.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Object
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">



   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000183">compute_path</a>&nbsp;&nbsp;
      <a href="#M000179">define</a>&nbsp;&nbsp;
      <a href="#M000180">find</a>&nbsp;&nbsp;
      <a href="#M000181">new</a>&nbsp;&nbsp;
      <a href="#M000182">parse_path</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">method</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000179" class="method-detail">
        <a name="M000179"></a>

        <div class="method-heading">
          <a href="EndPoint.src/M000179.html" target="Code" class="method-signature"
            onclick="popupCode('EndPoint.src/M000179.html');return false;">
          <span class="method-name">define</span><span class="method-args">(name, path, method, *options)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Registers a <a href="EndPoint.html#M000181">new</a> <a
href="EndPoint.html">EndPoint</a> named <tt>name</tt>.
</p>
<p>
<tt>path</tt> is the path on server which may include variables in braces,
e.g.
</p>
<pre>
  '/v1/users/{user_id}/profile'
</pre>
<p>
In this case, when you call <tt><a
href="EndPoint.html#M000183">compute_path</a></tt> for this <tt><a
href="EndPoint.html">EndPoint</a></tt>, you must include <tt>user_id</tt>
in <tt>params</tt>, which will be substituted into the url.
</p>
        </div>
      </div>

      <div id="method-M000180" class="method-detail">
        <a name="M000180"></a>

        <div class="method-heading">
          <a href="EndPoint.src/M000180.html" target="Code" class="method-signature"
            onclick="popupCode('EndPoint.src/M000180.html');return false;">
          <span class="method-name">find</span><span class="method-args">(name)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns the <a href="EndPoint.html">EndPoint</a> named <tt>name</tt>.
</p>
        </div>
      </div>

      <div id="method-M000181" class="method-detail">
        <a name="M000181"></a>

        <div class="method-heading">
          <a href="EndPoint.src/M000181.html" target="Code" class="method-signature"
            onclick="popupCode('EndPoint.src/M000181.html');return false;">
          <span class="method-name">new</span><span class="method-args">(path, method = :get, options = [])</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000182" class="method-detail">
        <a name="M000182"></a>

        <div class="method-heading">
          <a href="EndPoint.src/M000182.html" target="Code" class="method-signature"
            onclick="popupCode('EndPoint.src/M000182.html');return false;">
          <span class="method-name">parse_path</span><span class="method-args">(path)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000183" class="method-detail">
        <a name="M000183"></a>

        <div class="method-heading">
          <a href="EndPoint.src/M000183.html" target="Code" class="method-signature"
            onclick="popupCode('EndPoint.src/M000183.html');return false;">
          <span class="method-name">compute_path</span><span class="method-args">(params)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Computes the path to the <a href="EndPoint.html">EndPoint</a> by
substituting parameters from <tt>params</tt> into the path.
</p>
<p>
WARNING: This function DESTRUCTIVELY modifies the <tt>params</tt> hash that
you pass to it. This is normally what you want, since you don&#8216;t want
to substitute a parameter into the path and also pass it in the query
string, but make sure to make a copy first if you&#8216;re just passing in
parameters from another caller.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>